Mention GtkIconSize in all docs where the argument/return is annotated as taking...

In https://bugzilla.gnome.org/show_bug.cgi?id=601425 the annotations
were changed to int as they not only take the predefined enum values
but also user defined values registered through gtk_icon_size_register()

As a result the typelib doesn't contain any information about
GtkIconSize for those arguments and the Python docstring only
shows the corresponding Python type "int".

This changes the argument docs to mention the type explicitly
so the Python doc generator can add a link to Gtk.IconSize
which contains the most useful predefined values.

https://bugzilla.gnome.org/show_bug.cgi?id=757411

diff --git a/gtk/deprecated/gtkaction.c b/gtk/deprecated/gtkaction.c
index 03ed26e02cbbc739c413c87678b8ad386621e523..e857ab4ed419a509c674c765f643cf74a624d603 100644 (file)
--- a/gtk/deprecated/gtkaction.c
+++ b/gtk/deprecated/gtkaction.c
@@ -988,7 +988,8 @@ gtk_action_unblock_activate (GtkAction *action)
 /**
  * gtk_action_create_icon:
  * @action: the action object
- * @icon_size: (type int): the size of the icon that should be created.
+ * @icon_size: (type int): the size of the icon (#GtkIconSize) that should
+ *      be created.
  *
  * This function is intended for use by action implementations to
  * create icons displayed in the proxy widgets.

diff --git a/gtk/deprecated/gtkiconfactory.c b/gtk/deprecated/gtkiconfactory.c
index c1fc37072cba2623477b0ad1832b4448452a092f..5ac19ca1a065d5846cdc98006806905a780395c9 100644 (file)
--- a/gtk/deprecated/gtkiconfactory.c
+++ b/gtk/deprecated/gtkiconfactory.c
@@ -746,7 +746,7 @@ icon_size_lookup_intern (GtkIconSize  size,
  * gtk_icon_size_lookup_for_settings:
  * @settings: a #GtkSettings object, used to determine
  *   which set of user preferences to used.
- * @size: (type int): an icon size
+ * @size: (type int): an icon size (#GtkIconSize)
  * @width: (out) (allow-none): location to store icon width
  * @height: (out) (allow-none): location to store icon height
  *
@@ -780,7 +780,7 @@ gtk_icon_size_lookup_for_settings (GtkSettings *settings,
 
 /**
  * gtk_icon_size_lookup:
- * @size: (type int): an icon size
+ * @size: (type int): an icon size (#GtkIconSize)
  * @width: (out) (allow-none): location to store icon width
  * @height: (out) (allow-none): location to store icon height
  *
@@ -859,7 +859,7 @@ icon_size_register_intern (const gchar *name,
  * Registers a new icon size, along the same lines as #GTK_ICON_SIZE_MENU,
  * etc. Returns the integer value for the size.
  *
- * Returns: (type int): integer value representing the size
+ * Returns: (type int): integer value representing the size (#GtkIconSize)
  *
  * Deprecated: 3.10: Use #GtkIconTheme instead.
  */
@@ -878,7 +878,7 @@ gtk_icon_size_register (const gchar *name,
 /**
  * gtk_icon_size_register_alias:
  * @alias: an alias for @target
- * @target: (type int): an existing icon size
+ * @target: (type int): an existing icon size (#GtkIconSize)
  *
  * Registers @alias as another name for @target.
  * So calling gtk_icon_size_from_name() with @alias as argument
@@ -927,7 +927,7 @@ gtk_icon_size_register_alias (const gchar *alias,
  *
  * Looks up the icon size associated with @name.
  *
- * Returns: (type int): the icon size
+ * Returns: (type int): the icon size (#GtkIconSize)
  *
  * Deprecated: 3.10: Use #GtkIconTheme instead.
  */
@@ -1477,7 +1477,7 @@ gtk_icon_set_render_icon_pixbuf_for_scale (GtkIconSet       *icon_set,
  * gtk_icon_set_render_icon_pixbuf:
  * @icon_set: a #GtkIconSet
  * @context: a #GtkStyleContext
- * @size: (type int): icon size. A size of (GtkIconSize)-1
+ * @size: (type int): icon size (#GtkIconSize). A size of `(GtkIconSize)-1`
  *        means render at the size of the source and don’t scale.
  *
  * Renders an icon using gtk_render_icon_pixbuf(). In most cases,
@@ -1514,7 +1514,7 @@ G_GNUC_END_IGNORE_DEPRECATIONS;
  * gtk_icon_set_render_icon_surface:
  * @icon_set: a #GtkIconSet
  * @context: a #GtkStyleContext
- * @size: (type int): icon size. A size of (GtkIconSize)-1
+ * @size: (type int): icon size (#GtkIconSize). A size of `(GtkIconSize)-1`
  *        means render at the size of the source and don’t scale.
  * @scale: the window scale to render for
  * @for_window: (allow-none): #GdkWindow to optimize drawing for, or %NULL
@@ -1562,7 +1562,7 @@ G_GNUC_END_IGNORE_DEPRECATIONS;
  * @style: (allow-none): a #GtkStyle associated with @widget, or %NULL
  * @direction: text direction
  * @state: widget state
- * @size: (type int): icon size. A size of (GtkIconSize)-1
+ * @size: (type int): icon size (#GtkIconSize). A size of `(GtkIconSize)-1`
  *        means render at the size of the source and don’t scale.
  * @widget: (allow-none): widget that will display the icon, or %NULL.
  *          The only use that is typically made of this
@@ -1724,7 +1724,7 @@ gtk_icon_set_add_source (GtkIconSet          *icon_set,
  * gtk_icon_set_get_sizes:
  * @icon_set: a #GtkIconSet
  * @sizes: (array length=n_sizes) (out) (type int): return location
- *     for array of sizes
+ *     for array of sizes (#GtkIconSize)
  * @n_sizes: location to store number of elements in returned array
  *
  * Obtains a list of icon sizes this icon set can render. The returned
@@ -2310,7 +2310,7 @@ gtk_icon_source_set_state (GtkIconSource *source,
 /**
  * gtk_icon_source_set_size:
  * @source: a #GtkIconSource
- * @size: (type int): icon size this source applies to
+ * @size: (type int): icon size (#GtkIconSize) this source applies to
  *
  * Sets the icon size this icon source is intended to be used
  * with.
@@ -2378,7 +2378,7 @@ gtk_icon_source_get_state (const GtkIconSource *source)
  * Obtains the icon size this source applies to. The return value
  * is only useful/meaningful if the icon size is not wildcarded.
  *
- * Returns: (type int): icon size this source matches.
+ * Returns: (type int): icon size (#GtkIconSize) this source matches.
  *
  * Deprecated: 3.10: Use #GtkIconTheme instead.
  */

diff --git a/gtk/deprecated/gtkstyle.c b/gtk/deprecated/gtkstyle.c
index 2cad590d26e7a4cd8d739dd3c83ea674edad4f81..664330d54acde59733cd97a958594ece15fb526c 100644 (file)
--- a/gtk/deprecated/gtkstyle.c
+++ b/gtk/deprecated/gtkstyle.c
@@ -1289,8 +1289,8 @@ gtk_style_real_set_background (GtkStyle    *style,
  * @source: the #GtkIconSource specifying the icon to render
  * @direction: a text direction
  * @state: a state
- * @size: (type int): the size to render the icon at. A size of
- *     (GtkIconSize)-1 means render at the size of the source and
+ * @size: (type int): the size to render the icon at (#GtkIconSize). A size of
+ *     `(GtkIconSize)-1` means render at the size of the source and
  *     don’t scale.
  * @widget: (allow-none): the widget
  * @detail: (allow-none): a style detail
@@ -4736,8 +4736,8 @@ gtk_widget_class_path (GtkWidget *widget,
  * gtk_widget_render_icon:
  * @widget: a #GtkWidget
  * @stock_id: a stock ID
- * @size: (type int): a stock size. A size of (GtkIconSize)-1 means
- *     render at the size of the source and don’t scale (if there are
+ * @size: (type int): a stock size (#GtkIconSize). A size of `(GtkIconSize)-1`
+ *     means render at the size of the source and don’t scale (if there are
  *     multiple source sizes, GTK+ picks one of the available sizes).
  * @detail: (allow-none): render detail to pass to theme engine
  *

diff --git a/gtk/gtkbutton.c b/gtk/gtkbutton.c
index ce0c272c5057f2c41902b17f6ca08c0be78b6fd4..012d64f16224818dde1ad7bdf9693800145f4312 100644 (file)
--- a/gtk/gtkbutton.c
+++ b/gtk/gtkbutton.c
@@ -1417,7 +1417,7 @@ gtk_button_new_with_label (const gchar *label)
 /**
  * gtk_button_new_from_icon_name:
  * @icon_name: an icon name
- * @size: (type int): an icon size
+ * @size: (type int): an icon size (#GtkIconSize)
  *
  * Creates a new button containing an icon from the current icon theme.
  *

diff --git a/gtk/gtkimage.c b/gtk/gtkimage.c
index 4ac0931996fb9d2074b713aeb97963c1c4aed950..82f7d7cae925d37854d8ffa936e5e4f82ca38f5b 100644 (file)
--- a/gtk/gtkimage.c
+++ b/gtk/gtkimage.c
@@ -697,7 +697,7 @@ gtk_image_new_from_surface (cairo_surface_t *surface)
 /**
  * gtk_image_new_from_stock:
  * @stock_id: a stock icon name
- * @size: (type int): a stock icon size
+ * @size: (type int): a stock icon size (#GtkIconSize)
  * 
  * Creates a #GtkImage displaying a stock icon. Sample stock icon
  * names are #GTK_STOCK_OPEN, #GTK_STOCK_QUIT. Sample stock sizes
@@ -728,7 +728,7 @@ gtk_image_new_from_stock (const gchar    *stock_id,
 /**
  * gtk_image_new_from_icon_set:
  * @icon_set: a #GtkIconSet
- * @size: (type int): a stock icon size
+ * @size: (type int): a stock icon size (#GtkIconSize)
  *
  * Creates a #GtkImage displaying an icon set. Sample stock sizes are
  * #GTK_ICON_SIZE_MENU, #GTK_ICON_SIZE_SMALL_TOOLBAR. Instead of using
@@ -796,7 +796,7 @@ gtk_image_new_from_animation (GdkPixbufAnimation *animation)
 /**
  * gtk_image_new_from_icon_name:
  * @icon_name: an icon name
- * @size: (type int): a stock icon size
+ * @size: (type int): a stock icon size (#GtkIconSize)
  * 
  * Creates a #GtkImage displaying an icon from the current icon theme.
  * If the icon name isn’t known, a “broken image” icon will be
@@ -823,7 +823,7 @@ gtk_image_new_from_icon_name (const gchar    *icon_name,
 /**
  * gtk_image_new_from_gicon:
  * @icon: an icon
- * @size: (type int): a stock icon size
+ * @size: (type int): a stock icon size (#GtkIconSize)
  * 
  * Creates a #GtkImage displaying an icon from the current icon theme.
  * If the icon name isn’t known, a “broken image” icon will be
@@ -1090,7 +1090,7 @@ gtk_image_set_from_pixbuf (GtkImage  *image,
  * gtk_image_set_from_stock:
  * @image: a #GtkImage
  * @stock_id: a stock icon name
- * @size: (type int): a stock icon size
+ * @size: (type int): a stock icon size (#GtkIconSize)
  *
  * See gtk_image_new_from_stock() for details.
  *
@@ -1129,7 +1129,7 @@ gtk_image_set_from_stock  (GtkImage       *image,
  * gtk_image_set_from_icon_set:
  * @image: a #GtkImage
  * @icon_set: a #GtkIconSet
- * @size: (type int): a stock icon size
+ * @size: (type int): a stock icon size (#GtkIconSize)
  *
  * See gtk_image_new_from_icon_set() for details.
  *
@@ -1211,7 +1211,7 @@ gtk_image_set_from_animation (GtkImage           *image,
  * gtk_image_set_from_icon_name:
  * @image: a #GtkImage
  * @icon_name: an icon name
- * @size: (type int): an icon size
+ * @size: (type int): an icon size (#GtkIconSize)
  *
  * See gtk_image_new_from_icon_name() for details.
  * 
@@ -1245,7 +1245,7 @@ gtk_image_set_from_icon_name  (GtkImage       *image,
  * gtk_image_set_from_gicon:
  * @image: a #GtkImage
  * @icon: an icon
- * @size: (type int): an icon size
+ * @size: (type int): an icon size (#GtkIconSize)
  *
  * See gtk_image_new_from_gicon() for details.
  * 
@@ -1363,7 +1363,7 @@ gtk_image_get_pixbuf (GtkImage *image)
  * @stock_id: (out) (transfer none) (allow-none): place to store a
  *     stock icon name, or %NULL
  * @size: (out) (allow-none) (type int): place to store a stock icon
- *     size, or %NULL
+ *     size (#GtkIconSize), or %NULL
  *
  * Gets the stock icon name and size being displayed by the #GtkImage.
  * The storage type of the image must be %GTK_IMAGE_EMPTY or
@@ -1397,7 +1397,7 @@ gtk_image_get_stock  (GtkImage        *image,
  * @icon_set: (out) (transfer none) (allow-none): location to store a
  *     #GtkIconSet, or %NULL
  * @size: (out) (allow-none) (type int): location to store a stock
- *     icon size, or %NULL
+ *     icon size (#GtkIconSize), or %NULL
  *
  * Gets the icon set and size being displayed by the #GtkImage.
  * The storage type of the image must be %GTK_IMAGE_EMPTY or
@@ -1453,8 +1453,8 @@ gtk_image_get_animation (GtkImage *image)
  * @image: a #GtkImage
  * @icon_name: (out) (transfer none) (allow-none): place to store an
  *     icon name, or %NULL
- * @size: (out) (allow-none) (type int): place to store an icon size,
- *     or %NULL
+ * @size: (out) (allow-none) (type int): place to store an icon size
+ *     (#GtkIconSize), or %NULL
  *
  * Gets the icon name and size being displayed by the #GtkImage.
  * The storage type of the image must be %GTK_IMAGE_EMPTY or
@@ -1487,8 +1487,8 @@ gtk_image_get_icon_name  (GtkImage     *image,
  * @image: a #GtkImage
  * @gicon: (out) (transfer none) (allow-none): place to store a
  *     #GIcon, or %NULL
- * @size: (out) (allow-none) (type int): place to store an icon size,
- *     or %NULL
+ * @size: (out) (allow-none) (type int): place to store an icon size
+ *     (#GtkIconSize), or %NULL
  *
  * Gets the #GIcon and size being displayed by the #GtkImage.
  * The storage type of the image must be %GTK_IMAGE_EMPTY or

diff --git a/gtk/gtkrender.c b/gtk/gtkrender.c
index 27fd591747a189c62d2232c8052e9dc22b63b7de..6be35a0c21d189b6bd5274939bcac834865a551d 100644 (file)
--- a/gtk/gtkrender.c
+++ b/gtk/gtkrender.c
@@ -1097,8 +1097,9 @@ gtk_render_icon_pixbuf_unpacked (GdkPixbuf           *base_pixbuf,
  * gtk_render_icon_pixbuf:
  * @context: a #GtkStyleContext
  * @source: the #GtkIconSource specifying the icon to render
- * @size: (type int): the size to render the icon at. A size of (GtkIconSize) -1
- *        means render at the size of the source and don’t scale.
+ * @size: (type int): the size (#GtkIconSize) to render the icon at.
+ *        A size of `(GtkIconSize) -1` means render at the size of the source
+ *        and don’t scale.
  *
  * Renders the icon specified by @source at the given @size, returning the result
  * in a pixbuf.

diff --git a/gtk/gtkscalebutton.c b/gtk/gtkscalebutton.c
index 4b7040f39f45d55c25938b649873ea21a2023f2e..cdca312c3fdad5766b6e7670c632cd66460d4aee 100644 (file)
--- a/gtk/gtkscalebutton.c
+++ b/gtk/gtkscalebutton.c
@@ -496,7 +496,7 @@ gtk_scale_button_dispose (GObject *object)
 
 /**
  * gtk_scale_button_new:
- * @size: (type int): a stock icon size
+ * @size: (type int): a stock icon size (#GtkIconSize)
  * @min: the minimum value of the scale (usually 0)
  * @max: the maximum value of the scale (usually 100)
  * @step: the stepping of value when a scroll-wheel event,

diff --git a/gtk/gtktoolshell.c b/gtk/gtktoolshell.c
index bd63eddebb570180dd73c395020f3ebb7d0c16c6..7dae16e7cd8c8402b2cebe447d483dc895ad9af9 100644 (file)
--- a/gtk/gtktoolshell.c
+++ b/gtk/gtktoolshell.c
@@ -90,7 +90,7 @@ gtk_tool_shell_real_get_ellipsize_mode (GtkToolShell *shell)
  * Retrieves the icon size for the tool shell. Tool items must not call this
  * function directly, but rely on gtk_tool_item_get_icon_size() instead.
  *
- * Returns: (type int): the current size for icons of @shell
+ * Returns: (type int): the current size (#GtkIconSize) for icons of @shell
  *
  * Since: 2.14
  **/

diff --git a/gtk/gtktooltip.c b/gtk/gtktooltip.c
index 5ccd83249b18840c0f53aa3ac7f121954d452b36..7a46aee6087f65e83e4679affae97b51d9fa8366 100644 (file)
--- a/gtk/gtktooltip.c
+++ b/gtk/gtktooltip.c
@@ -288,7 +288,7 @@ gtk_tooltip_set_icon (GtkTooltip *tooltip,
  * gtk_tooltip_set_icon_from_stock:
  * @tooltip: a #GtkTooltip
  * @stock_id: (allow-none): a stock id, or %NULL
- * @size: (type int): a stock icon size
+ * @size: (type int): a stock icon size (#GtkIconSize)
  *
  * Sets the icon of the tooltip (which is in front of the text) to be
  * the stock item indicated by @stock_id with the size indicated
@@ -314,7 +314,7 @@ gtk_tooltip_set_icon_from_stock (GtkTooltip  *tooltip,
  * gtk_tooltip_set_icon_from_icon_name:
  * @tooltip: a #GtkTooltip
  * @icon_name: (allow-none): an icon name, or %NULL
- * @size: (type int): a stock icon size
+ * @size: (type int): a stock icon size (#GtkIconSize)
  *
  * Sets the icon of the tooltip (which is in front of the text) to be
  * the icon indicated by @icon_name with the size indicated
@@ -338,7 +338,7 @@ gtk_tooltip_set_icon_from_icon_name (GtkTooltip  *tooltip,
  * gtk_tooltip_set_icon_from_gicon:
  * @tooltip: a #GtkTooltip
  * @gicon: (allow-none): a #GIcon representing the icon, or %NULL
- * @size: (type int): a stock icon size
+ * @size: (type int): a stock icon size (#GtkIconSize)
  *
  * Sets the icon of the tooltip (which is in front of the text)
  * to be the icon indicated by @gicon with the size indicated

diff --git a/gtk/gtkwidget.c b/gtk/gtkwidget.c
index a1dbdf84196c3c755b971609497d41bd48c97dae..564f795360775693c6f5234ab08179030a2db60e 100644 (file)
--- a/gtk/gtkwidget.c
+++ b/gtk/gtkwidget.c
@@ -10665,8 +10665,8 @@ gtk_widget_create_pango_layout (GtkWidget   *widget,
  * gtk_widget_render_icon_pixbuf:
  * @widget: a #GtkWidget
  * @stock_id: a stock ID
- * @size: (type int): a stock size. A size of (GtkIconSize)-1 means
- *     render at the size of the source and don’t scale (if there are
+ * @size: (type int): a stock size (#GtkIconSize). A size of `(GtkIconSize)-1`
+ *     means render at the size of the source and don’t scale (if there are
  *     multiple source sizes, GTK+ picks one of the available sizes).
  *
  * A convenience function that uses the theme engine and style